Refactor protocol structure by codingjoe · Pull Request #59 · codingjoe/VoIP

codingjoe · 2026-03-25T15:46:43Z

No description provided.

codecov · 2026-03-25T15:47:56Z

Codecov Report

❌ Patch coverage is 91.75947% with 37 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.66%. Comparing base (3f97385) to head (69115ae).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
voip/__main__.py	0.00%	35 Missing ⚠️
voip/sip/types.py	92.85%	2 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (3f97385) and HEAD (69115ae). Click for more details.

HEAD has 8 uploads less than BASE

Flag BASE (3f97385) HEAD (69115ae)

16 8

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
- Coverage   93.93%   87.66%   -6.27%     
==========================================
  Files          24       26       +2     
  Lines        1994     1954      -40     
==========================================
- Hits         1873     1713     -160     
- Misses        121      241     +120

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codingjoe · 2026-03-25T18:42:25Z

@copilot add tests, 100% or it didn't happen. No mocks, follow the superjoe and contributing guidelines.

…coverage

Co-authored-by: codingjoe <1772890+codingjoe@users.noreply.github.com> Agent-Logs-Url: https://github.com/codingjoe/VoIP/sessions/dd6b4390-f976-4e9d-ae5f-e207b4c92ae9

Copilot · 2026-03-25T19:06:03Z

@copilot add tests, 100% or it didn't happen. No mocks, follow the superjoe and contributing guidelines.

Done in d6657e5. Added 100% line coverage for all SIP files changed in this PR:

tests/sip/conftest.py — shared FakeTransport, fixtures, test SIP message constants
tests/sip/test_protocol.py — full coverage of SessionInitiationProtocol (connection lifecycle, keepalive, PING/PONG, request/response dispatch, contact header, allowed methods)
tests/sip/test_transactions.py — full coverage of Transaction, RegistrationTransaction (digest auth with SHA-256/MD5/qop), and InviteTransaction (invite/ack/bye/cancel/ringing/reject/answer)
Extended test_messages.py and test_types.py to cover remaining branches

No mocks — only transport is stubbed per CONTRIBUTING.md guidelines. 342 tests pass total.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

releases.astral.sh
- Triggering command: /home/REDACTED/.local/bin/uv uv run pytest tests/sip/ -q (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

codingjoe · 2026-03-25T19:52:59Z

@copilot unit tests must match the API they are testing. e.G. MyClass has a single TestMyClass test class. Methods will be test_function__raise_value_error so on and so forth.

…scenario naming Co-authored-by: codingjoe <1772890+codingjoe@users.noreply.github.com> Agent-Logs-Url: https://github.com/codingjoe/VoIP/sessions/50ee7641-f523-4ea5-b7b9-ac597fe93272

Copilot · 2026-03-25T20:00:57Z

@copilot unit tests must match the API they are testing. e.G. MyClass has a single TestMyClass test class. Methods will be test_function__raise_value_error so on and so forth.

Done in 4762b05. Restructured all test files to one TestMyClass per API class:

test_protocol.py: 10+ TestSessionInitiationProtocol* classes → single TestSessionInitiationProtocol
test_messages.py: renamed TestSIPMessage → TestMessage; merged TestMessageProperties, TestRequestFromDialog, TestResponseFromRequest into their parent classes
test_types.py: merged TestSipUriMaddr into TestSipUri
test_transactions.py: removed class name prefix from TestRegistrationError methods (test_registration_error__* → test_*); fixed __bytes__ method tests to test___bytes__

All 343 tests still pass at 100% SIP coverage.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

releases.astral.sh
- Triggering command: /home/REDACTED/.local/bin/uv uv run pytest tests/sip/ -q (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot

Pull request overview

This PR refactors the SIP stack by moving request/response handling into explicit transaction classes, introduces a shared NetworkAddress type for host/port values, and renames the RTP call-leg base class from RTPCall to Session. It updates the CLI, docs, and tests accordingly.

Changes:

Add NetworkAddress and apply it across STUN/RTP/SIP addressing and logging.
Extract SIP REGISTER/INVITE behaviors into voip/sip/transactions.py and simplify SessionInitiationProtocol to dispatch to transactions.
Rename RTP call leg handler base class (RTPCall → Session) and update docs/tests.

Reviewed changes

Copilot reviewed 27 out of 28 changed files in this pull request and generated 20 comments.

Show a summary per file

File	Description
voip/types.py	Adds `NetworkAddress` helper type used across networking layers.
voip/stun.py	Switches STUNProtocol APIs to accept `NetworkAddress`.
voip/rtp.py	Renames `RTPCall`→`Session` and migrates address typing to `NetworkAddress`.
voip/audio.py	Updates `AudioCall` base class to the new `Session`.
voip/sip/messages.py	Adds dialog/branch/tag helpers and introduces `Dialog`.
voip/sip/types.py	Extends `SipUri` with `maddr/ttl/transport` helpers and hides password in repr.
voip/sip/transactions.py	New transaction layer with REGISTER + INVITE transaction logic.
voip/sip/protocol.py	Refactors protocol to transaction dispatch and keepalive logic.
voip/sip/exceptions.py	New module for `RegistrationError`.
voip/sip/init.py	Re-exports transaction classes.
voip/sdp/types.py	Makes several SDP dataclasses frozen for immutability.
voip/sdp/messages.py	Adds slots to `SessionDescription`.
voip/main.py	Refactors CLI wiring to use transactions + `NetworkAddress`.
tests/, tests/sip/	Updates/rewrites tests to align with the refactor and new APIs.
docs/*, mkdocs.yml, README.md	Updates docs/nav/examples for the new structure and class names.
CONTRIBUTING.md, .pre-commit-config.yaml	Adjusts contributing guidance and pre-commit configuration.

Comments suppressed due to low confidence (1)

docs/sessions.md:3

Spelling: "Dessions" should be "Sessions".

for more information, see https://pre-commit.ci

Copilot · 2026-03-26T12:14:26Z

@codingjoe I've opened a new pull request, #61, to work on those changes. Once the pull request is ready, I'll request review from you.

`data_received()` assumed each TCP chunk was exactly one complete SIP message. TCP is a stream protocol — frames can be split across multiple deliveries or coalesced into one. ## Changes - **`recv_buffer: bytearray`** — accumulates raw bytes from the TCP stream across `data_received()` calls - **`PING` / `PONG` constants** — module-level `typing.Final[bytes]` constants (`b"\r\n\r\n"` and `b"\r\n"`) replace all scattered byte literals in the keepalive path - **`extract_frames()`** — generator that extracts complete frames from the buffer using `Content-Length` header framing ([RFC 3261 §18.3](https://datatracker.ietf.org/doc/html/rfc3261#section-18.3)); yields a `memoryview` into the buffer for each SIP message (zero-copy until `Message.parse` needs `bytes`) and the `PING`/`PONG` constants for keepalive frames; the view is explicitly released before the buffer is compacted; partial messages remain buffered until all bytes arrive - **`dispatch_frame()`** — routes a single complete frame (`memoryview | bytes`) to the appropriate handler, converting to `bytes` only at parse time - **`data_received()`** — appends to `recv_buffer` and iterates the `extract_frames()` generator ```python def data_received(self, data: bytes) -> None: self.recv_buffer.extend(data) for frame in self.extract_frames(): self.dispatch_frame(frame) ``` ## Tests 39 new tests covering: split headers, split body, coalesced messages, all keepalive edge cases (partial PING, PONG-then-message, etc.), invalid `Content-Length`, and end-to-end `data_received` reassembly scenarios.  --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: codingjoe <1772890+codingjoe@users.noreply.github.com> Co-authored-by: Johannes Maron <johannes@maron.family>

codingjoe self-assigned this Mar 25, 2026

Refactor protocol structure

a4e0a48

codingjoe force-pushed the transactions branch from 8a56683 to a4e0a48 Compare March 25, 2026 18:35

codingjoe assigned Copilot Mar 25, 2026

Copilot started work on behalf of codingjoe March 25, 2026 18:42 View session

Copilot AI and others added 2 commits March 25, 2026 19:00

Add comprehensive SIP protocol, transaction, and type tests for 100% …

9328516

…coverage

Add 100% test coverage for SIP protocol/transaction layer

d6657e5

Co-authored-by: codingjoe <1772890+codingjoe@users.noreply.github.com> Agent-Logs-Url: https://github.com/codingjoe/VoIP/sessions/dd6b4390-f976-4e9d-ae5f-e207b4c92ae9

Copilot finished work on behalf of codingjoe March 25, 2026 19:06

Copilot started work on behalf of codingjoe March 25, 2026 19:53 View session

Reorganize test classes: one TestMyClass per API class, test_method__…

4762b05

…scenario naming Co-authored-by: codingjoe <1772890+codingjoe@users.noreply.github.com> Agent-Logs-Url: https://github.com/codingjoe/VoIP/sessions/50ee7641-f523-4ea5-b7b9-ac597fe93272

Copilot finished work on behalf of codingjoe March 25, 2026 20:02

codingjoe marked this pull request as ready for review March 25, 2026 20:29

Copilot AI review requested due to automatic review settings March 25, 2026 20:29

Copilot started reviewing on behalf of codingjoe March 25, 2026 20:29 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

codingjoe and others added 2 commits March 26, 2026 12:02

Address review comments

403c4d6

[pre-commit.ci] auto fixes from pre-commit.com hooks

62fbb93

for more information, see https://pre-commit.ci

Copilot AI mentioned this pull request Mar 26, 2026

Add TCP stream buffering to SessionInitiationProtocol #61

Merged

codingjoe and others added 3 commits March 26, 2026 13:17

Update tests

b440ecc

Bump to Python 3.14 +

c52507d

codingjoe merged commit 11102db into main Mar 26, 2026
13 checks passed

codingjoe deleted the transactions branch March 26, 2026 15:21

Uh oh!

Conversation

codingjoe commented Mar 25, 2026

Uh oh!

codecov Bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codingjoe commented Mar 25, 2026

Uh oh!

Copilot AI commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

codingjoe commented Mar 25, 2026

Uh oh!

Copilot AI commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Mar 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Mar 25, 2026 •

edited

Loading

Copilot AI commented Mar 25, 2026 •

edited

Loading

Copilot AI commented Mar 25, 2026 •

edited

Loading